Skip to content

docs: fix Realtime docstring wording - #3535

Merged
marcuswood-oai merged 5 commits into
openai:mainfrom
marcelpetrick:mpe/typoFixes
Sep 15, 2026
Merged

docs: fix Realtime docstring wording#3535
marcuswood-oai merged 5 commits into
openai:mainfrom
marcelpetrick:mpe/typoFixes

Conversation

@marcelpetrick

@marcelpetrick marcelpetrick commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Non-functional changes only:

  • Fixed minor spelling mistakes in comments
  • Corrected typos in user-facing strings
  • No variables, logic, or functional code was modified.
  • I understand that this repository is auto-generated and my pull request may not be merged

Changes being requested

Integrate the typo-fixes.

Additional context & links

None.

@marcelpetrick
fix(docs): correct typos found during code review
0496eb1 
Non-functional changes only:
- Fixed minor spelling mistakes in comments
- Corrected typos in user-facing strings
- No variables, logic, or functional code was modified.

Signed-off-by: Marcel Petrick <mail@marcelpetrick.it>
@marcelpetrick
marcelpetrick requested a review from a team as a code owner July 23, 2026 16:07
@marcelpetrick

marcelpetrick commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

@jbeckwith-oai @HAYDEN-OAI @sandeep-oai Hello, while checking the code I made some discoveries and fixed them. Hope it helps.

@marcelpetrick

marcelpetrick commented Aug 24, 2026

Copy link
Copy Markdown
Contributor Author

Greetings @sandeep-oai and others - are the changes of any help for you? I will most likely ping in some weeks again.

@marcuswood-oai marcuswood-oai changed the title fix(docs): correct typos found during code review docs: fix Realtime docstring wording Sep 15, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 15, 2026 •
edited
Loading

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-15T18:01:05.348937Z f55da1a New commits
🔒 Security Review ✅ Completed 2026-09-15T18:04:27.160975Z f55da1a New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Castiron custom code

Mixed files: 43 → 45

2 newly customized · 0 customizations removed · 0 existing customizations changed · 0 generated baselines changed

Compared 1493321affb1 → f55da1a1540f. Generated baselines verified.

File Result Current custom patch
src/openai/types/realtime/conversation_item_input_audio_transcription_delta_event.py Newly customized +1 / −1
src/openai/types/realtime/realtime_error_event.py Newly customized +1 / −1
43 existing customizations unchanged
  • api.md
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.py
  • src/openai/init.py
  • src/openai/_client.py
  • src/openai/resources/audio/transcriptions.py
  • src/openai/resources/audio/translations.py
  • src/openai/resources/beta/agents/sessions/sessions.py
  • src/openai/resources/beta/beta.py
  • src/openai/resources/beta/responses/responses.py
  • src/openai/resources/beta/threads/runs/runs.py
  • src/openai/resources/beta/threads/threads.py
  • src/openai/resources/chat/completions/completions.py
  • src/openai/resources/embeddings.py
  • src/openai/resources/files.py
  • src/openai/resources/live/forks.py
  • src/openai/resources/live/live.py
  • src/openai/resources/live/sideband.py
  • src/openai/resources/realtime/realtime.py
  • src/openai/resources/responses/responses.py
  • src/openai/resources/uploads/uploads.py
  • src/openai/resources/vector_stores/file_batches.py
  • src/openai/resources/vector_stores/files.py
  • src/openai/resources/videos.py
  • src/openai/resources/webhooks/init.py
  • src/openai/resources/webhooks/webhooks.py
  • src/openai/types/beta/agent_session_message.py
  • src/openai/types/chat/init.py
  • src/openai/types/chat/chat_completion_message_tool_call.py
  • src/openai/types/fine_tuning/fine_tuning_job_integration.py
  • src/openai/types/responses/init.py
  • src/openai/types/responses/response.py
  • src/openai/types/responses/response_function_web_search.py
  • src/openai/types/responses/response_function_web_search_param.py
  • src/openai/types/responses/responses_client_event.py
  • src/openai/types/responses/responses_client_event_param.py
  • src/openai/types/responses/tool.py
  • src/openai/types/responses/tool_param.py
  • src/openai/types/webhooks/init.py

3 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 35005394788 --repo openai/openai-python \
  --name castiron-custom-code-35005394788-1 --dir /tmp/castiron-custom-code-35005394788-1
git apply --stat /tmp/castiron-custom-code-35005394788-1/custom-code.patch
cat /tmp/castiron-custom-code-35005394788-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin 1493321affb1814fba7b669892e376a119d8d36f f55da1a1540f3d83e30f8194cdbbee6c8a8320c2
python3 scripts/castiron/custom_code_report.py report \
  --base 1493321affb1814fba7b669892e376a119d8d36f \
  --head f55da1a1540f3d83e30f8194cdbbee6c8a8320c2 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-f55da1a1540f
cat /tmp/castiron-custom-code-f55da1a1540f/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

@marcuswood-oai ChatGPT Codex Connector

marcuswood-oai commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Thanks for the cleanup. The streaming comment correction is already on main through #3005, while the two Realtime wording changes still apply to the generated API descriptions.

@marcuswood-oai
marcuswood-oai added this pull request to the merge queue Sep 15, 2026
Merged via the queue into openai:main with commit 8cb9ded Sep 15, 2026
16 checks passed
@openai-sdks openai-sdks Bot mentioned this pull request Sep 15, 2026
Merged
pull Bot pushed a commit to Pyrex77/openai-python that referenced this pull request Sep 15, 2026
@openai-sdks
release: 3.14.1 (openai#3856)
5bae14c 
Automated Release PR
---


##
[3.14.1](openai/openai-python@v3.14.0...v3.14.1)
(2026-09-15)


### Bug Fixes

* **client:** validate retry limits and preserve application errors
([openai#3867](openai#3867))
([f86c721](openai@f86c721))
* correct typo "th" to "the" in StreamAlreadyConsumed error message
([openai#3022](openai#3022))
([7186203](openai@7186203))
* **examples:** correct Azure endpoint hostname
([openai#3298](openai#3298))
([543516c](openai@543516c))
* **examples:** refresh chat streaming examples
([openai#2974](openai#2974))
([54f460e](openai@54f460e))
* **examples:** split push-to-talk shebang arguments
([openai#3210](openai#3210))
([d241ed6](openai@d241ed6))
* **examples:** use uv in remaining Python launchers
([openai#3821](openai#3821))
([8c76c4f](openai@8c76c4f))
* log only metadata for Live WebSocket diagnostics
([openai#3865](openai#3865))
([ccc10f5](openai@ccc10f5))
* **responses:** skip structured parsing for commentary
([openai#3861](openai#3861))
([6520df1](openai@6520df1))


### Chores

* **examples:** bump module_client.py to gpt-5.6
([openai#3211](openai#3211))
([1493321](openai@1493321))
* remove unused fine-tuning data validators
([openai#3863](openai#3863))
([9640f29](openai@9640f29))


### Documentation

* clarify async client cleanup
([openai#2388](openai#2388))
([a3d83b5](openai@a3d83b5))
* clarify filenames for in-memory file uploads
([openai#3729](openai#3729))
([cb27380](openai@cb27380))
* **client:** correct retry jitter comment
([openai#2252](openai#2252))
([bdbbc16](openai@bdbbc16))
* fix Realtime docstring wording
([openai#3535](openai#3535))
([8cb9ded](openai@8cb9ded))
* fix reusing wording in Azure client docstrings
([openai#3061](openai#3061))
([dc625f9](openai@dc625f9))
* fix streaming comment typo
([openai#3005](openai#3005))
([d421d7a](openai@d421d7a))
* fix vector store polling helper paths
([openai#3101](openai#3101))
([2ef2de6](openai@2ef2de6))
* **readme:** correct SSE terminology
([openai#2837](openai#2837))
([caaa9b4](openai@caaa9b4))
* update Responses API reference link
([openai#3279](openai#3279))
([557bd06](openai@557bd06))
* **utils:** correct query component RFC reference
([openai#3300](openai#3300))
([929a8a5](openai@929a8a5))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: openai-sdks[bot] <284451331+openai-sdks[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sandeep-oai sandeep-oai sandeep-oai approved these changes
@marcuswood-oai marcuswood-oai marcuswood-oai approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@marcelpetrick @marcuswood-oai @sandeep-oai